Persistence Cleaning Workflow Using Utilities
The primary utility used for persistence data cleaning is lsclean. This utility requires a cleaning license, except under few scenarios where lsclean "repairs" the persistence data instead of "cleaning" it up. For example, the version 8.1.x (and later) libraries do not require a cleaning license to clean up trial license persistence because of difference in architecture.
NOTE The cleaning operation removes the complete persistence data, whereas the repairing operation fixes the corrupted data.
The cleaning license is generated using the utility lscgcln. This license safeguards against the misuse of cleaning options by restricting their usage. Without safeguards, cleaning licenses can be misused for removing the valid license usage information. In general, the cleaning license has a lifetime of 10 calendar days—the license will expire 10 days after its start date.
Vendors Generating Cleaning License Using lscgcln
The lscgcln utility is used to generate cleaning licenses of version 7, 8, 9, 10, 11, and later. Refer to the topic Choosing Cleaning License Version to learn more about the cleaning license versions.
Run the lscgcln utility using any of the following commands:
>lscgcln -f input file name
>The input file name is the name of the configuration file that contains the license parameters. You can use the configuration file lscgcln.opt to specify license parameters. Note that this file is optional. Instead, you can provide these details one by one, in the step 2, using the command line prompt.
>lscgcln option output file name
>The output file name is the name of the new or existing license file that will hold the cleaning license. However, do not specify the reserved keywords used by a computer system, like COM1. The option can be any of the following.
| Option | Details |
|---|---|
| -c |
For cleaning the commuter license information. To generate a cleaning license for a commuter license, lscgcln prompts for the feature-version, system locking code and hostname. |
| -t |
For cleaning the time tampering detection information. lscgcln does not prompt for a feature-version to clean up the time tampering persistence created by version 7.x.x client libraries, The version 8.0 and 8.1 (and later) client libraries create two different persistence data to store the time tamper information. Sentinel RMS provides two different time tamper cleaning licenses. >On a network system (the License Manager): The feature and version are not required for generating the cleaning license. However, it is preferred to be locked to the machine where the persistence needs to be cleaned. >On a standalone system: To clean standalone time tamper information, the cleaning license should include the feature and version. The lsclean utility would clean only the persistence-related to the specified feature and version. |
| -g |
For cleaning the grace licensing information on client systems only. Since grace license functionality is offered from Sentinel RMS v8.0 onward, the cleaning of its persistence is available only in Sentinel RMS versions 8.x.x (and later) libraries. |
| -r |
For cleaning the license revocation information on the License Manager only (used for method 2) |
| -p | For cleaning the trial license information. The version 8.1.x (and later) libraries do not require a cleaning license to clean up trial license persistence because of difference in architecture. The version 8.0 (and earlier) libraries creates two different formats of persistence to store standalone and network persistence information. Sentinel RMS provided two different cleaning licenses to clean persistence, one for standalone and the other for network. The persistence will be cleaned only for a specific feature-version. |
Lscgcln will prompt you for specifying certain information for the license to be created. Given below is a list of parameters shown by lscgcln:
| Parameters | v7 | v8 | v9 | v10 | v11 (and later) |
|---|---|---|---|---|---|
|
License Model
|
>-p >-c >-t |
>-p >-c >-t >-g >-r |
>-c >-t >-g >-r |
||
| License File Name
The file containing the cleaning license |
Yes | ||||
| Codegen Version
|
Yes | Yes | Yes | Yes | Yes |
| Network/standalone Flag | Yes (-p/-t) | Yes (-t) | |||
| Lock Selector* (optional) The hexadecimal representation of the criteria chosen |
Yes | ||||
| Locking Code (optional) | Yes | ||||
| License Start Year | Yes | ||||
| License Start Month | Yes | ||||
| License Start Date |
Yes | ||||
| Maximum number of times the license can be used
Specify a value between 1 to 32766 or press Enter for unlimited use |
Yes | ||||
| Multi-feature Flag (M)
Allows generating one cleaning license for multiple features |
No | No | No | Applies only to -t standalone case | |
| Number of features to be cleaned
Specify a value between 1 to 10. The default value is 1. |
No | No | No | Applies only if multi-feature flag is used | |
| Feature1** | Yes (for -c) | Yes (for -c) | Yes (for -c) |
Yes (for >–p >-c >-t (standalone) >-g ) |
Yes (for >-c >-t (standalone) >-g ) |
| Version1 | Yes (for -c) | Yes (for -c) | Yes (for -c) |
Yes (for >–p >-c >-t (standalone) >-g ) |
Yes (for >-c >-t (standalone) >-g ) |
| Feature2*** | No | No | No | Optional (for Multi feature -t standalone) |
Optional (for Multi feature -t standalone) |
| Version2 | |||||
| Feature3*** | |||||
| Version3 | |||||
| ... | |||||
| Host Name | Yes (-c) | ||||
* If lock selector is not specified, you will not be prompted for the locking code. To generate unlocked cleaning licenses, skip this field by pressing the Enter key. In the options file, the lock selector and locking code fields must be left blank to generate unlocked cleaning licenses.
** The feature name and version are not required for network time tampering (the state when the system clock is tampered on the License Manager).
*** For multi-feature cleaning licenses, you will be prompted for specifying the feature-versions accordingly.
NOTE For the Sentinel RMS versions earlier than 8.1.1, you also need to attach the license meter key while generating a cleaning license using the lscgcln utility. For later versions, this is not required.
Customers Using the lsclean Utility
Your customers can use the lsclean utility to clean up their systems.
NOTE Administrator (root) privileges are required to run the lsclean utility.
1.Copy the lsclean utility and the license file containing the cleaning license created by lscgcln to a directory on the customer’s computer.
2.Stop the License Manager (or exit the licensed application in the case of standalone licensing).
3.At a command prompt, type any of the options below:
| lsclean Option | Agenda | Applies to | |
|---|---|---|---|
| Standalone and/or Client | License Manager | ||
| Requires a cleaning license | |||
|
lsclean license file name
|
Cleans up the system using the cleaning license license file name generated by lscgcln and copied at the same location where lsclean exists. It is applicable to the following cases: |
||
|
>-c to clean the commuter license information |
Yes | Yes (8.3.x and earlier) | |
|
>-t to clean the time tampering detection information |
Yes | Yes | |
|
>-g to clean the grace licensing information |
Yes (8.0.0 onward) | Not applicable | |
|
>-r to clean the license revocation information (used for method 1 and 3) |
Not applicable | Yes (8.0.0 onward) | |
|
>-p to clean the trial license information |
Yes (8.0.x and earlier) | Yes (8.0.x and earlier) | |
| Does not require a cleaning license | |||
| lsclean -fixtrial
|
Repairs the trial license persistence data. |
Yes (8.1.0 onward) | Yes (8.1.0 onward) |
| lsclean -fixrevoke
|
Repairs the standalone revocation persistence data. |
Yes (8.2.x onward) | Not applicable |
| lsclean -fixserrevoke
|
Repairs the License Manager network revocation persistence data (when created using revocation procedure introduced in v8.5.3). |
Not applicable | Yes (8.5.3 onward) |
| lsclean -fixvtl
|
Repairs the volume transaction license persistence data. |
Yes (8.2.x onward) | Yes (8.2.x onward) |
| lsclean -fixsercom
|
Repairs the License Manager-side commuter license persistence data. |
Not applicable | Yes (8.4.x onward) |
| lsclean -fixsertrial
|
Repairs the License Manager-side trial license persistence data on Windows. |
Not applicable | Yes (8.6.x onward) |
| lsclean -fixservtl
|
Repairs the License Manager-side volume transaction license persistence data on Windows. |
Not applicable | Yes (8.6.x onward) |
| lsclean -fixserusglog | Recover corrupted usage log network persistence data. | Not Applicable | Yes (9.0.0 - 9.6.0) |
| lsclean -fixstdusglog | Recover corrupted usage log persistence data for standalone deployments. | Standalone only (9.0.0 - 9.6.0) | Not Applicable |
| lsclean -fixusglogguid | Recover corrupted usage log GUID persistence data. | Yes (9.0.0 onward) | Yes (9.0.0 onward) |
| lsclean -fixcancellease | Repairs the cancel lease persistence files for standalone deployments. | Standalone only (9.4.0 onward) | Not Applicable |
| lsclean -fixusglogrollover | Recover corrupted usage log file rollover persistence data. | Yes (9.7.0 onward) | Yes (9.7.0 onward) |
| lsclean -fixusglog | Recover corrupted usage log persistence data for standalone and network deployments. | Yes (9.7.0 onward) | Yes (9.7.0 onward) |
NOTE In Windows Vista, Windows 7, and Server 2008, you may include the -p switch to show the status in a new console. For example, the lsclean -fixtrial -p command repairs the trial license persistence and shows the status in a new console. This command has no impact on other Windows operating systems.
NOTE The lsclean -fixusglogguid switch is specific to machine and software vendor.
4.The clean.log log file will be created in the same directory. It will contain the details of the success or failure of lsclean to clean the computer of the specified information.
5.Start the License Manager for the change(s) to take effect (or, run the licensed application again in the case of standalone licensing).